8.2.1 Release Notes OneStream

OneStream 8.2.1 is a hotfix release that addresses performance degradation for certain configurations and error messages related to designated culture codes.

Hotfix 8.2.1 is operable with version 8.2.0 Excel Add-In and Windows clients.

For more information regarding this release, see the 8.2.1 Release Highlights course on OneStream Navigator.

Highlights

  • You can easily embed refreshable content allowing users to edit and narrate a document for the purpose of inserting content used in a published report. 

  • You can modify data of an underlying base table through a SQL view using the SQL Table Editor.

  • Task Activity allows users and administrators to cancel a long-running Cube View with Cube View paging (loading cube view pages) and Quick View paging (loading cube view pages).

  • The new Header Format property "HeaderWrapText" allows individual row and column header formats to independently wrap text in Data Explorer.

  • The Substitution Variable Items property in Workspaces allows a collection of static name and value pairs to be retrieved and used in dashboards and code.

Prerequisites

Refer to Requirements for important notices and details regarding planning your upgrade.

  • Framework and application database schema updates are not required for this upgrade. Full database backups are recommended.

  • Review the Upgrade Guide.

Important Notes

  • Microsoft has announced end of support for .NET 6 on 12 November 2024. Further details are available at https://dotnet.microsoft.com/en-us/platform/support/policy. OneStream plans to adopt Microsoft's Long-Term Support (LTS) .NET versions, which are released every two years and supported by Microsoft for three years. OneStream Platform v8.2 uses the .NET 8 development framework.

  • OneStream recommends that any credentialed integration with OneStream Platform should change passwords regularly.

  • Platform code migrated from System.Data.SqlClient to Microsoft.Data.SqlClient. For additional information, see Platform Version 8.0+ Readiness in the Upgrade Guide. (PF7-1295)

  • The following BRAPIs are scheduled for removal in a future release in a manner consistent with our sunset policy: BRApi.Utilities.EncryptText and BRApi.Utilities.DecryptText. Please update your business rules to use Key Management - Secrets found within the Cloud Administration Tools Marketplace Solution, or integrate with your own third-party secrets provider. (PF7-4417)

  • VPN or ExpressRoute used with OneStream cloud on Platform Releases prior to 8.0.0 will reach End of Service on 31 August 2024. All customers using VPN or ExpressRoute who are upgrading to Platform Release 8.0 or later will be required to migrate to Smart Integration Connector to integrate with local data sources. Cloud customers remaining on Platform Releases prior to 8.0.0 can continue to use VPN or ExpressRoute through the End of Service date, after which VPN will be out of support. Smart Integration Connector provides secure connectivity between a OneStream SaaS instance and customer data sources residing within a local network. See the Smart Integration Connector Guide for more information about enabling this feature in your environment.

  • ERPConnect45.dll is no longer included with OneStream and Smart Integration Connector. See the Smart Integration Connector Guide for referencing and integrating with the new ERPConnectStandard20.dll, available on the "DLL Packages" tile on the Platform page of Solution Exchange.

  • Customers in the OneStream-hosted environment will use OneStream IdentityServer for authentication and can manage identity providers (IdPs) and personal access tokens (PATs) in the Identity & Access Management Portal. See the Identity and Access Management Guide.

  • OneStream supports Windows Server 2019 and 2022.

  • OneStream Client operation supports Windows 10 and 11.

  • .NET8 Desktop Runtime must be installed to local desktops and laptops to successfully operate the Windows Application Client in a Platform Release 8.2 environment. See the Platform v8+ Upgrade Group in ONECommunity. (PF7-3087)

  • Didisoft.pgp.dll for PGP encryption is included within OneStream. You can reference this DLL directly on the Properties page of your Business rule as Didisoft.pgp.dll. (PF7-1481)

  • OneStream has provided authentication capabilities to increase security against social engineering vulnerabilities.

    • Cloud customers

      These enhancements are included in v8.2 OneStream IdentityServer (OIS) with no impact to existing OIS setup or end-user login flow.

      OneStream cloud customers with legacy authentication upgrading to Platform v8.2 will assume these increased security enhancements with their OIS migration during the Platform v8.2 upgrade.

    • Self-hosted customers

      Self-hosted customers (all operate with legacy SSO authentication) may opt in to these security enhancements through Web Server configuration changes. See the Installation and Configuration Guide for details. These authentication enhancements are disabled for self-hosted installations by default, resulting in no impact upon upgrading to Platform v8.2. (PF7-6193, PF7-5868)

New Features

Modify Table Data through a View in SQL Table Editor

You can modify data of an underlying base table through an SQL View. An SQL View is a virtual table where column and row contents are defined by an SQL query. The SQL Table Editor displays data from the virtual table, but you can change the data of the underlying base table. This provides more flexibility and control over how you present and manipulate data in the SQL Table Editor. (PF1-9487)

Dynamic XF Docs

You can easily embed refreshable content allowing users to edit and narrate a document for the purpose of inserting content used in a published report. (PF6-4407)

Substitution Variable Items

The Substitution Variable Items property in Workspaces allows a collection of static name and value pairs to be retrieved and used in dashboards and code. (PF6-4408)

Task Activity Enhancements

Task Activity allows users and administrators to cancel a long-running Cube View with Cube View paging (loading cube view pages) and Quick View paging (loading cube view pages). (PF6-4391)

Dynamic Bound Parameters

Dynamic Bound Parameters allows you to have template parameters resolved inside of other parameters. (PF6-3376)

BI Blend Extended Architecture

Blend X is our latest extended architecture enhancement. It expands capabilities of the BI Blend Engine to integrate larger and more complex data sets. The new architecture includes three new Data Integration Dimensions that provide 57 new fields to capture text, numeric values and time. The Blend X architecture enables time-awareness in the BI Blend data set and provides for 40 pre-defined, time-based, computation methods to simplify the enrichment of the data for reporting.

Enhancements

  • Filtering Based on Other Columns: You can base a column’s header filter on values from another column. This includes any column that is in the data set, even if the column is hidden. This is useful for name-value pair parameter columns as long as the values and names are pulled from individual columns. (PF1-9438)

  • Resized Description Column in Journals: When the Journals page is open, the Description column defaults to a set size instead of auto-fitting to its longest cell value. You can still resize columns manually as needed. (PF1-9233)

  • Journal Line Item Dimension Member Descriptions: You can set a preference to hide or show the member description next to member names in journal line items. These preferences are saved on your local machine in OneStream user settings. (PF1-9182)

  • Intercompany Partner Entity Deletion: When an entity is used only as an intercompany partner, you cannot delete it. Previously, you could delete these entities, which caused orphaned data. Now, the system checks to determine whether the entity is an intercompany partner, and if so, it does not remove the entity. (PF1-9311)

  • Smart Integration Connector: MAX Gateways Validation: To enhance user experience and prevent surpassing the maximum number of five gateways, we have added a new validation feature to the Smart Integration Connector. The "Create New Gateway" button will automatically display a message once you have reached the maximum limit. This helps ensure you manage your gateways effectively. If you require more than five gateways, please contact support. (PF7-3800)
  • Smart Integration Connector: Connection String Password Masking: Passwords included in connection strings can be entered in a new password field that is secure and masked. This field will be referenced by the connection string using the new substitution variable delimiter, enhancing the security of your passwords. (PF7-3917)

  • Filter Editor: A new Dashboard component allows for Dashboard builders to create advanced filter expressions. See Dashboard Components.(PF5-2803)

  • BI Blend Logical Operators: Several new logical operators were added for working with BI Blend Derivatives.

IdeaStream Enhancements

  • Wrap Header Text: The new Header Format property "HeaderWrapText" allows individual row and column header formats to independently wrap text in Cube View Data Explorer displays. (PF5-3443)

  • Merge and Center Text: The new General property “MergeandCenterColumnHeader” allows for upper nested column headings in Cube View Data Explorer reports to be merged and centered. (PF5-3426)

  • Drill Down on XFScript: In the Excel Add-In and Spreadsheet, you can right-click on an XFScript cell to drill down into the details. (PF5-3375)

  • Data Explorer Quick View: In Data Explorer, you can right-click to create a Quick View using the POV from the selected cell. Select “Excel” to open the Quick View in the Excel Add-In, where you can modify the Quick View. (PF5-3345)

  • Renaming Journals: Journals in Working or Rejected status can be renamed by administrators or members of the workflow profile’s Journal Process Group security role. (PF1-9433)

  • Filter journals by Entity: You can filter journal entries based on the entity name. (PF1-9434)

Watch to see Platform Release 8.2 Enhancements from IdeaStream.

Fixed Issues

8.2.1

  • Performance Degradation: For some customer configurations, performance for job processing and interactive tasks may operate below anticipated levels. Corrective code ensures full utilization of available resources to provide optimal performance. (PF7-6805)

  • ‘Failure to compile’ Messages Pertaining to Designated Culture Codes: Users assigned to impacted culture codes will encounter ‘Failure to compile’ messages when interactively performing tasks associated with formulas or complex expressions. Corrective code resolves this issue. (PF1-9913). The following culture codes are impacted:

    • et-EE (Estonian-Estonia)

    • eu-ES (Basque-Spain)

    • fi-FI (Finnish-Finland)

    • fo-DK (Faroese-Denmark)

    • fo-FO (Faroese-Faroe Islands)

    • gsw-CH (Swiss German-Switzerland)

    • gsw-FR (Swiss German-France)

    • gsw-LI (Swiss German-Liechtenstein)

    • ksh-DE (Colognian-Germany)

    • lt-LT (Lithuanian-Lithuania)

    • nb-NO (Norwegian Bokmål-Norway)

    • nb-SJ (Norwegian Bokmål-Svalbard & Jan Mayen)

    • nn-NO (Norwegian Nynorsk-Norway)

    • rm-CH (Romansh-Switzerland)

    • se-FI (Northern Sami-Finland)

    • se-NO (Northern Sami-Norway)

    • se-SE (Northern Sami-Sweden)

    • sl-SI (Slovenian-Slovenia)

    • sv-AX (Swedish-Åland Islands)

    • sv-FI (Swedish-Finland)

    • sv-SE (Swedish-Sweden)

8.2.0

  • Collapse Locked Years in Journals: When copying journals, you can collapse locked years in the Time Period dialog box. Previously, you were unable to collapse a locked year after it was expanded. (PF1-9436)

  • Copy Journals Dialog Box: The Copy Journals dialog box size is set to a default height and width so that it no longer expands off the screen vertically or horizontally. This previously occurred when copying more than 30 journals or when copying journals with long descriptions. You can still resize the dialog box, or individual columns, as needed. (PF1-9126)

  • Locked Time Periods in Journals: When copying journals, the Target Time Period dialog box will no longer let you select time periods that are completed. A completed check mark displays next to the time period to indicate that status. This prevents copy errors. (PF1-9435)

  • Hidden Header/Footer Code in Formula Editor: Header and footer code in the Formula Editor is no longer displayed as it cannot be edited. You can, however, still expand and collapse sections of your own code. (PF1-9461)

  • File Attachment Automatic Refresh: The File Attachment dialog box in workflow Forms and Journals now clears the file name after a file is deleted. (PF1-9466)

  • Smart Integration Connector: Timeout Error: You will no longer encounter a timeout when attempting to retrieve data from a SQL Server stored procedure that takes 12+ minutes to run. This issue affected Release 8.0.0. (PF7-3904, PF7-4615)

  • Smart Integration Connector: Remote BR Error: You can invoke remote BRs on a Gateway with parameters of DataTables or Datasets as datatypes. This issue affected Release 8.1.0. (PF7-4154)

  • Smart Integration Connector: Azure to Gateway Multiple Requests Error: If a request fails repeatedly and there is no response within 10 seconds, it will be canceled, and an entry will be logged in the error log. Importantly, this will not affect other requests, which will proceed without being held up in queue due to the repeated failed Azure Gateway requests. This ensures smoother and more efficient operations. This issue affected Release 8.0.0. (PF7-4166)

  • Smart Integration Connector: Custom Config Location Error: If the SIC Configuration file has been placed in a custom location, this custom file will be opened as the default when the utility is opened. This issue affected Release 8.1.0. (PF7-4178)

  • Smart Integration Connector: Business Rules Encryption Button Error: The business rule encryption button will be disabled for Smart Integration Function Business Rules to eliminate the risk that the complication will fail. This issue affected Release 8.1.0. (PF7-4344)

  • Smart Integration Connector: Null values are now being returned. Object DBNull Error: Users will no longer see the “object cannot be cast from DBNull to other types” error when attempting to query a dataset that contains Null values. This issue affected Releases 8.0.0 and 8.1.0. (PF7-4412, PF7-4194)

  • Smart Integration Connector: Correct row count is now being returned when returning a DataTable using smart integration functions (remote business rules). This issue affected Release 8.1.0. (PF7-4497)

  • Saving Component with Confirmation Dialog Box: When creating a new component, changing an application, or ending a session and clicking on the Close button, a confirmation dialog box will display ensuring if you want to continue with the options of OK or Cancel to close the page or save changes. (PF6-4544)

  • Saving Data in a Dashboard or Workflow Form with Confirmation Dialog Box: After entering data in a dashboard or workflow form, when selecting the Close button to close out of the application, end the session, or change an application, a confirmation dialog box will display ensuring if you want to continue with the options of OK or Cancel to close the page or save changes. (PF6-4541)

  • Saving a Dashboard with Unsaved Changes with Confirmation Dialog Box: When rerunning a dashboard after previously selecting OK in the confirmation dialog box, it will display again when changes have been made to a dashboard and certain actions are performed. (PF6-4514).

  • Cube View Group Drop-down When Copying a Cube View: To copy a Cube View under Application> Presentation>Cube Views, select a Cube View and then select the <copy> toolbar button. A pop-up dialog box displays and populates the current Cube View Group. The drop-down only shows Cube View Groups in the Default Workspace/Default Maintenance Unit. (PF6-4456).

  • Data Management Sequence Parameters: The Data Management Sequence parameters automatically populate in the schedule task where the data management resides within a Workspace or outside a Workspace, such as the default Workspace/default Maintenance Unit. (PF6-4977)

  • Data Management Copy/Paste Numbering: When pasting Data Management Sequences or Steps, only the last instance of the number in the parenthesis is incremented if the copied item exists. (PF6-4485)

  • Data Management Step and Group Tree Path Expands: The tree hierarchy path only expands for newly created steps, even if another step with the same name exists within the same Data Management Groups folder. (PF6-4280)

  • Load/Extract-Extract Applications and Workspaces: When extracting and loading Application zip or Workspace in xfProject, the enum value has changed from XFBookFileSourceType.ApplicationWorkspaceFile back to XFBookFileSourceType.ApplicationDashboardFile. (PF6-4795)

  • Components Using Image File Source Type of Dashboard File: Components with the Image File Source Type = DashboardFile display properly. (PF6-4501)

  • Application Workspaces Page Overlapped with OnePlace Pane: The application Workspaces page displays all information without scrolling left after running a dashboard. (PF6-4534)

  • Literal Parameter Values in xfProject: When you extract “Literal Parameter Values”, “Text 1”, and “Text 2” in xfProject, the expected values will display in their designated locations in the XML file. (PF6-4950)

  • Data Adapters Using Service Factory: The report component displays the first record for the username field from a Default Workspace/Non-default Maintenance Unit and a Shared Workspace that runs a dashboard with a standard data adapter of {WSMU}{GetMyData}. (PF6-4899)

  • Using Identity in Table Column Names: The SQL Table Editor component will not error when the column using IDENTITY is within the Table Column Names property and is increment by SQL. When you perform an update, you cannot modify the IDENTITY field. (PF6-4821)

  • Copying/Pasting a Sequence or Step into a New Data Management Group: When copying or pasting a sequence or step into a new Data Management Group, you can select the new sequence or step visible within the tree hierarchy. (PF6-4498)

  • Dashboard Navigation: When you run a dashboard with a button whose Navigation Action property is set to “Open Page," the non-default Workspace is not shareable, and the Workspace is prefixed, the dashboard will run successfully. (PF6-4494)

  • Load Dashboard File Images from a Non-Default Workspace: When loading dashboard file images into Gantt, Map, or Tree View Controls from a Non-Default Workspace>Dashboard, the images display successfully. (PF6-4489)

  • Dashboard Background Color: The dashboard design tree will display with a white background instead of the same background color as the dashboard. (PF6-4142)

  • Create Copies of the Same Assemblies Group: You can make a second copy of the original assembly created and listed within the same assemblies group. Assembly Names cannot contain spaces, so the second copy’s name will not include a space. (PF6-3759)

  • Buttons Launch in Cube Views: You can click a button to open a new page that runs a Cube View successfully by opening a Data Explorer page. (PF6-5070)

  • Text Editor Comments: You can add comments in Text Editor. (PF6-4925)

  • Dashboard Spreadsheet: If you have a Dashboard with a spreadsheet component that contains “Save Data for All Components” enabled, you can save spreading changes in a spreadsheet component in a dashboard using the save button in its configuration. (PF6-3408)

  • Workspace Assembly System.IO.Packaging.ddl: To reference the System.IO.Packaging /access items in the System.IO.Packaging assembly within a Workspace assembly or a business rule and compile, you will need to add the following code to reference the System.IO.Packaging.dll from the appropriate location: compilerParameters.ReferencedAssemblies.Add (typeof(System.IO.Packaging.Package).Assembly.Location); (PF6-4824).

  • Cube View Uiltem IntelliSense: To use Cube View Uiltem IntelliSense, modify the business rule in Cube View Extender> GDR_CubeViewHelper, add a line at line 37, and type “uiItem.” for a drop-down to appear. (PF6-4414)

  • Assembly File Names: Assembly File names (C# and VB) that begin with or contain numbers will be prefixed with an underscore. If they contain any special characters, it will be replaced with an underscore. (PF6-3895)

  • Workspace Assembly Service Factory: You can uninstall a particular MarketPlace solution and reinstall successfully without displaying an error stating it’s unable to find the Workspace Assembly Service Factory class while in an environment with two or more application servers. (PF6-5012, 5048)

  • File Explorer Special Characters: File names containing “( )” or “&” can be opened from File Explorer. (PF5-3629)

  • Quick View Behavior: Double-click behavior in Quick Views performs as expected. (PF5-3597)

  • Quick View Error: When using Quick Views with Excel Tables the "ClearOutline method of Range class failed" error is resolved. (PF5-3591)

  • Task Scheduler: Tooltips display Expire Date/Time correctly in Calendar View and Grid View for all task scheduled before evening/afternoon run times. (PF5-3593)

  • Task Scheduler: In default Workspaces, Parameter Name and Value display and can be edited in the Create/Edit Task dialog box after saving. (PF5-3592)

  • Task Scheduler: Grid View Date in column Next Start Date/Time displays “NA” when a task is disabled or expired. (PF5-3588)

  • Task Scheduler: Minutely tasks without a "To" and "From" date display correctly. (PF5-3565)

  • Task Scheduler: Minutely tasks without an "Expire Date/Time" run as scheduled. (PF5-3565)

  • Task Scheduler: Tasks are running appropriately, but expired and disabled tasks are displaying in Calendar View and Grid View under Next Start Date/Time. (PF5-3281)

  • Excel 2001 and Newer: The “Invalidate Old Data When Workbook is Opened” option is recognized by open workbooks. (PF5-3590)

  • Report Book Error: "(502) Bad Gateway." error when opening Report Books in File Explorer is resolved.

  • Time-Based One Time Passwords: To reduce the risk of unauthorized authentication requests we have added the ability to allow administrators to require a time-based onetime password (“TOTP”) to be entered when authenticating with the customer’s IdP and before the user credentials are validated. The TOTP generates a six character, alphanumeric code that must be entered within 30 seconds of being prompted and is only available on redirect from the successful IdP authentication. (PF7-6193)

Known Issues

  • Use of cube view Memberfilter Where Clause with HasChildren=True is only supported on dimensions assigned to the Default scenario type. (PF-21833)

  • The Large Data Pivot Grid duplicates items in the field list on the initial launch. After a field is dragged to a column or row, duplicate fields no longer show. (PF-31427)

  • If you are in a self-hosted environment that has upgraded to Platform Release 8.1 or later and your Network Security settings block loopbacks, you will encounter an error with your REST API calls. To resolve this error, see OneStream Knowledge Base article KB0012911. (PF7-4202)

  • The Whitelisted Domains setting in the Application Server Configuration file only allows for http and https formatted domains. References to non-http or non-https file schemes will no longer be allowed. (PF2-15004)

  • If you are in a self-hosted environment using a SAML 2.0 external identity provider for authentication and encounter an error, update the ACS URL both in the Web Server Configuration file in OneStream and in the application registration for the external identity provider. Use this format: https://<domainname>/OneStreamWeb/OneStreamLogonCallback.aspx/

    See OneStream Knowledge Base article KB0012777. (PF2-15177)

  • If you are in a self-hosted environment using a Microsoft Azure AD (Microsoft Entra ID) identity provider for authentication and encounter an error, add the tenant ID in the Web Server Configuration file in OneStream. See OneStream Knowledge Base article KB0012778. (PF2-15181)

  • If you are a commercial customer in a self-hosted environment using Microsoft Azure AD (Microsoft Entra ID) for authentication and encounter an error, update the redirect URL both in the Web Server Configuration file in OneStream and in the application registration in Microsoft Azure AD (Microsoft Entra ID) from https://onestreamclient to https://<domainname>/OneStreamWeb/OneStreamLogonCallback.aspx

    See OneStream Knowledge Base article KB0012781. (PF2-14668)

  • If you are in a self-hosted environment using a Microsoft Azure AD (Microsoft Entra ID) identity provider for REST API authentication and encounter an error, add the claim aud in the ordered lookups in the Web Server Configuration file in OneStream. See OneStream Knowledge Base article KB0012779. (PF2-15031)

  • If you are in a self-hosted environment using a PingFederate identity provider for REST API authentication and encounter an error, add the claim client_id in the ordered lookups in the Web Server Configuration file in OneStream. See OneStream Knowledge Base article KB0012780. (PF2-15027)

  • Smart Integration Connector transfers data in Apache Parquet format from the Local Gateway Service to OneStream. If you are transferring a data type that is unsupported by parquet, the data returns as a string. (PF2-15235)

  • You may see failures or errors with Smart Integration Connector when processing parallel tasks. As a workaround, reduce the number of parallel tasks being processed at once to help mitigate these issues. (PF7-5876)

  • In the Task Scheduler Calendar View, weekly and monthly tasks created to run in the evening or nightly display additional days. (PF5-3538)

  • When creating a new Custom Database Server Connection, invalid connection strings are saved without an error message that allows for a correction. (PF5-3692)

  • If you have an Extensible Document with a large number of Cube Views and click the Refresh Document button, it will display the embedded content. If you reprocess the document, it will take some time to reprocess. (PF6-5088)

  • When an XF Doc calls an Excel document with a 3D chart, it does not display. (PF6-5004)

  • For Task Scheduler in custom Workspaces, Parameter Name and Value do not display in the Create/Edit Task dialog box after saving. (PF5-3592)

  • Personal Access Tokens (PATs) created in OneStream Identity Server (OIS) need to be re-generated when upgrading to OneStream 8.2 to align with the 2024 Microsoft maintenance window. (PF7-6486)

  • The Server URL is not displayed within the Windows Application header for all OneStream Hosted Customers with OIS and for Self-Hosted Customers using Azure OIDC External SSO with the OIDC Local Redirect Port enabled. (PF7-6479)

Solutions Moving to OpenPlace or Sunset

The following solutions will be moving to OpenPlace in August of 2024:

  • Actor Workspace

  • Close Manager

  • Dimension Comparison Utility

  • Help Desk

  • PowerShell Scripting

  • Process Control Manager

  • Provision Request Manager

  • Tax Provision

  • Train Me (Video Help)

  • Standard Cube View Styles

The following solutions will be sunset in August of 2024 and will no longer be supported by OneStream:

  • End User Training - Cube View

  • End User Training - Excel Analysis

  • End User Training - Extensible Docs

  • End User Training - Report Books

  • End User Training - Spreadsheet Analysis

  • End User Training - Videos

  • End User Training - Workflow

  • Process Blocker

Contact Support

Contact OneStream Support by registering at:

Support - OneStream Software